CASI API - Data Set Publication Instance

Returns the content of a data set published from the CASI Data Designer

Path Parameters

Parameter	Description
scheme	Scheme ID number
publication

Get Publication GET

Gets a published data set from the CASI Data Designer.

In XML and JSON formats the Data element contains the current published version of the data set. The LastBuild, NextBuild and ScheduleFrequency detail when the data set was last updated and when it is scheduled be refreshed.

The data set may also be downloaded directly in CSV or Excel (.xls or .xlsx) formats by specifying the appropriate content type in the Accept header, or by using the URL quoted on the test tab.

Parameters

Response Parameters

Parameter	Name	Type	Description
Name		String (Optional)
Description		String (Optional)
LastBuilt		Date / Time (Optional)
NextBuild		Date / Time (Optional)
ScheduleFrequency		Date / Time (Optional)

XML

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/reports/datasets/certifiers/{publication}.eb HTTP/1.1
Accept: text/xml

Response Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="Publication">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="Name" minOccurs="0" type="xsd:string" />
        <xsd:element name="Description" minOccurs="0" type="xsd:string" />
        <xsd:element name="LastBuilt" minOccurs="0" type="xsd:dateTime" />
        <xsd:element name="NextBuild" minOccurs="0" type="xsd:dateTime" />
        <xsd:element name="ScheduleFrequency" minOccurs="0" type="xsd:dateTime" />
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<Publication>
  <Name>xsd:string</Name>
  <Description>xsd:string</Description>
  <LastBuilt>xsd:dateTime</LastBuilt>
  <NextBuild>xsd:dateTime</NextBuild>
  <ScheduleFrequency>xsd:dateTime</ScheduleFrequency>
</Publication>

Download full schema

JSON

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/reports/datasets/certifiers/{publication}.eb HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"Name":String,
  "Description":String,
  "LastBuilt":String,
  "NextBuild":String,
  "ScheduleFrequency":String}

CSV

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/reports/datasets/certifiers/{publication}.eb HTTP/1.1
Accept: text/csv

Example Response

HTTP/1.1 200 OK
Content-Type: text/csv

...

XLS

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/reports/datasets/certifiers/{publication}.eb HTTP/1.1
Accept: application/vnd.ms-excel

Example Response

HTTP/1.1 200 OK
Content-Type: application/vnd.ms-excel

...

XLSX

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/reports/datasets/certifiers/{publication}.eb HTTP/1.1
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Example Response

HTTP/1.1 200 OK
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

...